/*
 * The MIT License
 * Copyright (c) 2012 kc4.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.kc4.sso.session;

/**
 * @author yoichi kikuchi
 */
public interface SSOSessionStore {

	/**
	 * ストアに、SSO セッションが存在するかどうかを取得します。
	 *
	 * @param authorizationToken 認証トークン。
	 * @return ストアにトークンが存在する場合は true、それ以外の場合は false。
	 */
	public boolean exist(String authorizationToken);

	/**
	 * ストアから、認証トークンに該当する SSO セッションを削除します。
	 *
	 * @param authorizationToken 認証トークン。
	 */
	public void remove(String authorizationToken);

	/**
	 * ストアから、SSO セッションを取得します。
	 *
	 * @param authorizationToken 認証トークン。
	 * @return SSO セッション。
	 */
	public SSOSession get(String authorizationToken);

	/**
	 * ストアへ、SSO セッションを設定します。
	 * オブジェクト保存のキーとなる、authorizationToken は引数オブジェクト内に保持されています。
	 *
	 * @param session SSO セッション。
	 */
	public void set(SSOSession session);
}
